Move user-facing docs to the docs site; reorganize developer-docs/ - #125
Merged
Conversation
developer-docs/ had a mix of user/operator/admin guides (installing a
watcher, adding an instrument, managing tokens, upgrading the watcher)
and reference docs (REST API, MCP server) that duplicated — or were
superseded by — the polished docs site at arcadia-data-hub-docs.vercel.app.
- Delete developer-docs/guides/ (adding-an-instrument, installing-a-watcher,
managing-tokens, upgrading-the-watcher) and developer-docs/reference/
{api,mcp}.md — all fully covered by the docs site now.
- Preserve the two pieces of dev-only content those files carried that
weren't duplicated anywhere else: the S3 trigger + deploy step for adding
a Lambda processor (folded into the docs site's deploying-aws-infrastructure
page) and the 0022_pat_scopes wildcard-backfill rationale (added to
architecture.md's design decisions).
- Repoint every remaining cross-reference (READMEs, reference/*.md,
watcher/pyproject.toml) at the docs site instead of the deleted files.
- Add a Documentation section to AGENTS.md directing agents to the docs
site for user/operator/admin questions, since developer-docs/ now only
covers contributing to Data Hub itself.
Co-authored-by: Cursor <cursoragent@cursor.com>
The Guides/Reference split no longer earned its keep once guides/ shrank to a single entry — Reference also mixed genuine reference docs (watcher, lambda, shared-library) with conceptual/onboarding ones (architecture, getting-started, conventions). Flatten into one ordered list, and add the missing link to ops/run-archives.md. Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
developer-docs/guides/,reference/api.md,reference/mcp.md) from this repo — that content now lives on the docs site, including a new standalone MCP server page and a Lambda-processor section folded into the AWS infrastructure guide.developer-docs/(no morereference//ops/subdirectories) and addsdeveloper-docs/README.mdas the doc index, replacing the inline list that used to live in the rootREADME.md.developer-docs/testing.mdconsolidating the per-package test setup (sharedstart_test_server()fixture, S3 mocking, Vitest suite split) that was previously scattered across several files.fe-test-mcpMakefile target /test:mcpnpm script tofe-test-unit/test:unit, since it coverstests/unit/as well astests/mcp/, not just MCP protocol tests.README.mdto drop the now-stale inline doc list and surface the zero-credential local-dev path next to the main setup steps.AGENTS.mdin this repo to point agents at the docs site for user-facing questions and atdeveloper-docs/README.mdfor the contributor index.watcher/README.md,watcher/pyproject.toml,infra/template.yaml, CI workflow, etc.).Test plan
make check-allpasses (Python + web lint/format/typecheck)make fe-test-unitpasses under its new namedeveloper-docs/README.mdand rootREADME.mdon GitHub for broken linksMade with Cursor